Meta-Data Registry Rules (container)

Rule Name:

Correct Configuration Baseline

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Base

Default:

Checked

Usage:

The configuration field of the record is checked for correctness. If no content is found, the term "IEEE 1489" is added.  If the term "IEEE P1489" is found, it is changed to be "IEEE 1489"  (the P indicates that an IEEE document is a draft, this document is now adopted, so the P is removed).  If any other text is found, it is left alone.  If changes were made, a note is added to the log and displayed.

Rule Name:

Correct CLASSIFICATION SCHEME use

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Base2

Default:

Checked

Usage:

The CLASS_SCHEME field of the record is checked for correctness. If no content is found, the term "IEEE 1489" is added.  If the term "IEEE P1489" is found, it is changed to be "IEEE 1489"  (the P indicates that an IEEE document is a draft, this document is now adopted, so the P is removed).  If the term "IEEE 1489-1999" is found, it is changed to be "IEEE 1489" instead.  This last case is an example of the sort of mindless control word lists (CWLs) that the original data registry defined as being correct.     If any other text is found, it is left alone.  If changes were made, a note is added to the log and displayed.

Rule Name:

Correct Schema Version

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Schema

Default:

Checked

Usage:

The CLASS_VER field of the record is checked for correctness.  If no content is found, the term "1.0" is added.  This is the only defined item in the CWL for this field.  If changes were made, a note is added to the log and displayed.

Rule Name:

Set Class name to be ITS if blank

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Class

Default:

Checked

Usage:

The CLASS_NAME  field of the record is checked for correctness. If no content is found, the term "ITS" is added.  There are a large number of possible control word terms here, with categories like “System Management-Transit” or “Moving Components-Vehicle Probe Data” etc. The list has never enjoyed wide use or review, however IEEE 1488/89 specified that you must pick a term from it.

Aside:   You can see the list in the edit window when in verbose mode, it is called “Class Name”]  The rules also specify that when a concept is used in more than one place (as most are) that the term “ITS” is to be used.  Hence, we use this as the default term here to produce an “IEEE 1488/89 conformant” record.  If changes were made, a “nag” note is added to the log and displayed suggesting the user may want to pick a better name.

Rule Name:

Set OID value to zero if blank

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_OID

Default:

UN-Checked

Usage:

The OID field (object Identifier) of the record is checked for correctness. If no content is found, the term "0000" is added.  In order to be “IEEE 1488/89 conformant” a record must have an OID of some value, but no specific numbering value systems is provided. 

Some device type standards (such as NTCIP) make use of the OID value and employ a numbering off the NEMA part of the tree which they can relate to the MIB.  Others use a mix of free text here. Most ITS message sets do not use or need an OID.  If an OID is present in the record it is printed in various reports. If changes were made, a note is added to the log and displayed.

Rule Name:

Set Descriptive Name Context value to Manage Traffic if blank

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Context

Default:

Checked

Usage:

The DESC_NAME_CONTEXT   field of the record is checked for correctness. If no content is found, the term "Manage Traffic" is added.  There are a large number of possible control word terms here, with categories like “Electronic Payment” or “Manage Archives” etc. The list has never enjoyed wide use or review, however IEEE 1488/89 specified that you must pick a term from it.

Aside:   You can see the list in the edit window when in verbose mode, it is called [“Desc. Name Context”]  The rules also allow that when a concept is used in more than one place (as most are) that the term “Manage Traffic” may be used.  Hence, we use this as the default term here to produce an “IEEE 1488/89 conformant” record.  If changes were made, a “nag” note is added to the log and displayed, suggesting the user may want to pick a better name.

Rule Name:

Set record revision to be zero if blank

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Revision

Default:

Checked

Usage:

The REG_REV field (registration revision) of the record is checked for correctness. If no content is found, the term "0" is added.  Any other content is left unchanged.  If this field has a numerical content, then the tool will automatically advance the value each time the data concept is edited and saved.  If changes were made, a note is added to the log and displayed.

Rule Name:

Set default record type to be Data Element if blank

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_RecordType

FIX with NEW CODE BASE!

Default:

Checked

Usage:

The RecordType field of the record is checked for content. If no content is found, it is set to be a “Data Element” type.  Any other content is left unchanged.  If changes were made, a note is added to the log and displayed.

Rule Name:

Warn if SOURCE standard is blank

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_Source

Default:

UN-Checked

Usage:

The Source field of the record is checked for content. If no content is found, it is set to be a “Unknown” type.  Any other content is left unchanged with the presumption it is the name of a real standard.  If changes were made, a “nag” note is added to the log and displayed suggesting the user may want to pick a better name. 

Rule Name:

Auto Set VOLUME MAP from SOURCE field

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_VolMap

Default:

UN-Checked

Usage:

The Source and the Vol_Map fields of the record are examined for content. If some source content is found, AND if the volume map is set to all volumes (“00”) then the source is examined to attempt to detect what specific volume(s) the record belongs in. The source string is compared to a series of keywords to determine which standard it relates to.  This provides a crude way to properly set the volumes map for a group of records.  At this time, only the IEEE 1512 “Incident Management” effort (with 5 volumes at present) makes use of this feature.  [Aside: It may be that NTCIP comes to use it ]  Note that the volume map field can hold a sequence of volumes that a record is to appear in (i.e. 01, 02, 04, 05), although the values “00”  (all volumes) or a single value is more common.  If changes were made, a note is added to the log and displayed.

Rule Name:

Warn if set to ALL in the VOLUME MAP

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_TagAllVol

Default:

UN-Checked

Usage:

The Vol_Map field of the record is examined for content. If the volume map is set to use the record in all volumes (“00” or empty) then a warning is provided.  For single volume documents, the value of “00” is used, and presents no problems. 

If a standard is to be divided and published into separate volumes, very few or almost no records would remain in the “00” category.  This rule provides an easy way to find any such records. 

As a matter of good systems engineering, records should never be defined more than once, hence they do not appear in multiple volumes.  By contrast, terms and acronyms (another two tables in which the records use a volume map) are often repeated in each volume.  

Rule Name:

Set all records in table to appear in Volume One only

Position:

Under: Meta-Data Registry Rules 

Name:

Meta_SetVol_1

Default:

UN-Checked

Usage:

The Vol_Map field of the record is examined for content. The value is set to “01” so that the record will appear in the first volume of the set. If changes were made, a note is added to the log and displayed.